Azure OpenAI (preview:2024-07-01)

2025/02/20 • 7 updated methods

ListAssistants (updated)
Description :  Gets a list of assistants that were previously created.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ListAssistants",
  "$parameters": [
    {
      "#name": "before",
      "Description": {
        "new": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.",
        "old": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list."
      }
    }
  ]
}

⚼ Request

GET:  /assistants
{
limit:
{
Description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. ,
Format: int32 ,
Required: False ,
}
integer ,
order:
{
Description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. ,
Required: False ,
}
string ,
after:
{
Description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. ,
Required: False ,
}
string ,
before:
{
Description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: The object type, which is always list. ,
Enum:
{
list: No description available. ,
}
,
Required: True ,
}
enum ,
data:
{
Description: The requested list of items. ,
Required: True ,
}
[
{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always assistant. ,
Enum:
{
assistant: No description available. ,
}
,
Required: True ,
}
enum ,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
name:
{
Description: The name of the assistant. ,
Required: True ,
}
string ,
description:
{
Description: The description of the assistant. ,
Required: True ,
}
string ,
model:
{
Description: The ID of the model to use. ,
Required: True ,
}
string ,
instructions:
{
Description: The system instructions for the assistant to use. ,
Required: True ,
}
string ,
tools:
{
Description: The collection of tools enabled for the assistant. ,
Required: True ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
tool_resources:
{
Description: A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. ,
Required: True ,
}
object ,
temperature:
{
Description: What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. ,
Format: float ,
Required: True ,
}
number ,
top_p:
{
Description: An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both. ,
Format: float ,
Required: True ,
}
number ,
response_format:
{
Description: The response format of the tool calls used by this assistant. ,
Required: False ,
}
string ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: True ,
}
object ,
}
,
]
,
first_id:
{
Description: The first ID represented in this list. ,
Required: True ,
}
string ,
last_id:
{
Description: The last ID represented in this list. ,
Required: True ,
}
string ,
has_more:
{
Description: A value indicating whether there are additional values available not captured in this list. ,
Required: True ,
}
boolean ,
}
ListMessages (updated)
Description :  Gets a list of messages that exist on a thread.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ListMessages",
  "$parameters": [
    {
      "#name": "before",
      "Description": {
        "new": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.",
        "old": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list."
      }
    }
  ]
}

⚼ Request

GET:  /threads/{threadId}/messages
{
threadId:
{
Description: The ID of the thread to list messages from. ,
Required: True ,
}
string ,
runId:
{
Description: Filter messages by the run ID that generated them. ,
Required: False ,
}
string ,
limit:
{
Description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. ,
Format: int32 ,
Required: False ,
}
integer ,
order:
{
Description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. ,
Required: False ,
}
string ,
after:
{
Description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. ,
Required: False ,
}
string ,
before:
{
Description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: The object type, which is always list. ,
Enum:
{
list: No description available. ,
}
,
Required: True ,
}
enum ,
data:
{
Description: The requested list of items. ,
Required: True ,
}
[
{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always 'thread.message'. ,
Enum:
{
thread.message: No description available. ,
}
,
Required: True ,
}
enum ,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
thread_id:
{
Description: The ID of the thread that this message belongs to. ,
Required: True ,
}
string ,
status:
{
Description: The status of the message. ,
Enum:
{
in_progress: A run is currently creating this message. ,
incomplete: This message is incomplete. See incomplete_details for more information. ,
completed: This message was successfully completed by a run. ,
}
,
Required: True ,
}
enum ,
incomplete_details:
{
Description: On an incomplete message, details about why the message is incomplete. ,
Required: True ,
}
object ,
completed_at:
{
Description: The Unix timestamp (in seconds) for when the message was completed. ,
Format: unixtime ,
Required: True ,
}
integer ,
incomplete_at:
{
Description: The Unix timestamp (in seconds) for when the message was marked as incomplete. ,
Format: unixtime ,
Required: True ,
}
integer ,
role:
{
Description: The role associated with the assistant thread message. ,
Enum:
{
user: The role representing the end-user. ,
assistant: The role representing the assistant. ,
}
,
Required: True ,
}
enum ,
content:
{
Description: The list of content items associated with the assistant thread message. ,
Required: True ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
assistant_id:
{
Description: If applicable, the ID of the assistant that authored this message. ,
Required: True ,
}
string ,
run_id:
{
Description: If applicable, the ID of the run associated with the authoring of this message. ,
Required: True ,
}
string ,
attachments:
{
Description: A list of files attached to the message, and the tools they were added to. ,
Required: True ,
}
[
{
file_id:
{
Description: The ID of the file to attach to the message. ,
Required: True ,
}
string ,
tools:
{
Description: The tools to add to this file. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: True ,
}
object ,
}
,
]
,
first_id:
{
Description: The first ID represented in this list. ,
Required: True ,
}
string ,
last_id:
{
Description: The last ID represented in this list. ,
Required: True ,
}
string ,
has_more:
{
Description: A value indicating whether there are additional values available not captured in this list. ,
Required: True ,
}
boolean ,
}
ListRuns (updated)
Description :  Gets a list of runs for a specified thread.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ListRuns",
  "$parameters": [
    {
      "#name": "before",
      "Description": {
        "new": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.",
        "old": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list."
      }
    }
  ]
}

⚼ Request

GET:  /threads/{threadId}/runs
{
threadId:
{
Description: The ID of the thread to list runs from. ,
Required: True ,
}
string ,
limit:
{
Description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. ,
Format: int32 ,
Required: False ,
}
integer ,
order:
{
Description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. ,
Required: False ,
}
string ,
after:
{
Description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. ,
Required: False ,
}
string ,
before:
{
Description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: The object type, which is always list. ,
Enum:
{
list: No description available. ,
}
,
Required: True ,
}
enum ,
data:
{
Description: The requested list of items. ,
Required: True ,
}
[
{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always 'thread.run'. ,
Enum:
{
thread.run: No description available. ,
}
,
Required: True ,
}
enum ,
thread_id:
{
Description: The ID of the thread associated with this run. ,
Required: True ,
}
string ,
assistant_id:
{
Description: The ID of the assistant associated with the thread this run was performed against. ,
Required: True ,
}
string ,
status:
{
Description: The status of the assistant thread run. ,
Enum:
{
queued: Represents a run that is queued to start. ,
in_progress: Represents a run that is in progress. ,
requires_action: Represents a run that needs another operation, such as tool output submission, to continue. ,
cancelling: Represents a run that is in the process of cancellation. ,
cancelled: Represents a run that has been cancelled. ,
failed: Represents a run that failed. ,
completed: Represents a run that successfully completed. ,
expired: Represents a run that expired before it could otherwise finish. ,
}
,
Required: True ,
}
enum ,
required_action:
{
Description: The details of the action required for the assistant thread run to continue. ,
Required: False ,
}
object ,
last_error:
{
Description: The last error, if any, encountered by this assistant thread run. ,
Required: True ,
}
object ,
model:
{
Description: The ID of the model to use. ,
Required: True ,
}
string ,
instructions:
{
Description: The overridden system instructions used for this assistant thread run. ,
Required: True ,
}
string ,
tools:
{
Description: The overridden enabled tools used for this assistant thread run. ,
Required: True ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
expires_at:
{
Description: The Unix timestamp, in seconds, representing when this item expires. ,
Format: unixtime ,
Required: True ,
}
integer ,
started_at:
{
Description: The Unix timestamp, in seconds, representing when this item was started. ,
Format: unixtime ,
Required: True ,
}
integer ,
completed_at:
{
Description: The Unix timestamp, in seconds, representing when this completed. ,
Format: unixtime ,
Required: True ,
}
integer ,
cancelled_at:
{
Description: The Unix timestamp, in seconds, representing when this was cancelled. ,
Format: unixtime ,
Required: True ,
}
integer ,
failed_at:
{
Description: The Unix timestamp, in seconds, representing when this failed. ,
Format: unixtime ,
Required: True ,
}
integer ,
incomplete_details:
{
Description: Details on why the run is incomplete. Will be `null` if the run is not incomplete. ,
Enum:
{
max_completion_tokens: Maximum completion tokens exceeded ,
max_prompt_tokens: Maximum prompt tokens exceeded ,
}
,
Required: True ,
}
enum ,
usage:
{
Description: Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). ,
Required: True ,
}
object ,
temperature:
{
Description: The sampling temperature used for this run. If not set, defaults to 1. ,
Format: float ,
Required: False ,
}
number ,
top_p:
{
Description: The nucleus sampling value used for this run. If not set, defaults to 1. ,
Format: float ,
Required: False ,
}
number ,
max_prompt_tokens:
{
Description: The maximum number of prompt tokens specified to have been used over the course of the run. ,
Format: int32 ,
Required: True ,
}
integer ,
max_completion_tokens:
{
Description: The maximum number of completion tokens specified to have been used over the course of the run. ,
Format: int32 ,
Required: True ,
}
integer ,
truncation_strategy:
{
Description: The strategy to use for dropping messages as the context windows moves forward. ,
Required: True ,
}
object ,
tool_choice:
{
Description: Controls whether or not and which tool is called by the model. ,
Required: True ,
}
string ,
response_format:
{
Description: The response format of the tool calls used in this run. ,
Required: True ,
}
string ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: True ,
}
object ,
}
,
]
,
first_id:
{
Description: The first ID represented in this list. ,
Required: True ,
}
string ,
last_id:
{
Description: The last ID represented in this list. ,
Required: True ,
}
string ,
has_more:
{
Description: A value indicating whether there are additional values available not captured in this list. ,
Required: True ,
}
boolean ,
}
ListRunSteps (updated)
Description :  Gets a list of run steps from a thread run.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ListRunSteps",
  "$parameters": [
    {
      "#name": "before",
      "Description": {
        "new": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.",
        "old": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list."
      }
    }
  ]
}

⚼ Request

GET:  /threads/{threadId}/runs/{runId}/steps
{
threadId:
{
Description: The ID of the thread that was run. ,
Required: True ,
}
string ,
runId:
{
Description: The ID of the run to list steps from. ,
Required: True ,
}
string ,
limit:
{
Description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. ,
Format: int32 ,
Required: False ,
}
integer ,
order:
{
Description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. ,
Required: False ,
}
string ,
after:
{
Description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. ,
Required: False ,
}
string ,
before:
{
Description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: The object type, which is always list. ,
Enum:
{
list: No description available. ,
}
,
Required: True ,
}
enum ,
data:
{
Description: The requested list of items. ,
Required: True ,
}
[
{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always 'thread.run.step'. ,
Enum:
{
thread.run.step: No description available. ,
}
,
Required: True ,
}
enum ,
type:
{
Description: The type of run step, which can be either message_creation or tool_calls. ,
Enum:
{
message_creation: Represents a run step to create a message. ,
tool_calls: Represents a run step that calls tools. ,
}
,
Required: True ,
}
enum ,
assistant_id:
{
Description: The ID of the assistant associated with the run step. ,
Required: True ,
}
string ,
thread_id:
{
Description: The ID of the thread that was run. ,
Required: True ,
}
string ,
run_id:
{
Description: The ID of the run that this run step is a part of. ,
Required: True ,
}
string ,
status:
{
Description: The status of this run step. ,
Enum:
{
in_progress: Represents a run step still in progress. ,
cancelled: Represents a run step that was cancelled. ,
failed: Represents a run step that failed. ,
completed: Represents a run step that successfully completed. ,
expired: Represents a run step that expired before otherwise finishing. ,
}
,
Required: True ,
}
enum ,
step_details:
{
Description: The details for this run step. ,
Required: True ,
}
{
type:
{
Description: The object type. ,
Enum:
{
message_creation: Represents a run step to create a message. ,
tool_calls: Represents a run step that calls tools. ,
}
,
Required: True ,
}
enum ,
}
,
last_error:
{
Description: If applicable, information about the last error encountered by this run step. ,
Required: True ,
}
object ,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
expired_at:
{
Description: The Unix timestamp, in seconds, representing when this item expired. ,
Format: unixtime ,
Required: True ,
}
integer ,
completed_at:
{
Description: The Unix timestamp, in seconds, representing when this completed. ,
Format: unixtime ,
Required: True ,
}
integer ,
cancelled_at:
{
Description: The Unix timestamp, in seconds, representing when this was cancelled. ,
Format: unixtime ,
Required: True ,
}
integer ,
failed_at:
{
Description: The Unix timestamp, in seconds, representing when this failed. ,
Format: unixtime ,
Required: True ,
}
integer ,
usage:
{
Description: Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`. ,
Required: False ,
}
object ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: True ,
}
object ,
}
,
]
,
first_id:
{
Description: The first ID represented in this list. ,
Required: True ,
}
string ,
last_id:
{
Description: The last ID represented in this list. ,
Required: True ,
}
string ,
has_more:
{
Description: A value indicating whether there are additional values available not captured in this list. ,
Required: True ,
}
boolean ,
}
ListVectorStores (updated)
Description :  Returns a list of vector stores.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ListVectorStores",
  "$parameters": [
    {
      "#name": "before",
      "Description": {
        "new": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.",
        "old": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list."
      }
    }
  ]
}

⚼ Request

GET:  /vector_stores
{
limit:
{
Description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. ,
Format: int32 ,
Required: False ,
}
integer ,
order:
{
Description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. ,
Required: False ,
}
string ,
after:
{
Description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. ,
Required: False ,
}
string ,
before:
{
Description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: The object type, which is always list. ,
Enum:
{
list: No description available. ,
}
,
Required: True ,
}
enum ,
data:
{
Description: The requested list of items. ,
Required: True ,
}
[
{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always `vector_store` ,
Enum:
{
vector_store: No description available. ,
}
,
Required: True ,
}
enum ,
created_at:
{
Description: The Unix timestamp (in seconds) for when the vector store was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
name:
{
Description: The name of the vector store. ,
Required: True ,
}
string ,
usage_bytes:
{
Description: The total number of bytes used by the files in the vector store. ,
Format: int32 ,
Required: True ,
}
integer ,
file_counts:
{
Description: Files count grouped by status processed or being processed by this vector store. ,
Required: True ,
}
{
in_progress:
{
Description: The number of files that are currently being processed. ,
Format: int32 ,
Required: True ,
}
integer ,
completed:
{
Description: The number of files that have been successfully processed. ,
Format: int32 ,
Required: True ,
}
integer ,
failed:
{
Description: The number of files that have failed to process. ,
Format: int32 ,
Required: True ,
}
integer ,
cancelled:
{
Description: The number of files that were cancelled. ,
Format: int32 ,
Required: True ,
}
integer ,
total:
{
Description: The total number of files. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
status:
{
Description: The status of the vector store, which can be either `expired`, `in_progress`, or `completed`. A status of `completed` indicates that the vector store is ready for use. ,
Enum:
{
expired: expired status indicates that this vector store has expired and is no longer available for use. ,
in_progress: in_progress status indicates that this vector store is still processing files. ,
completed: completed status indicates that this vector store is ready for use. ,
}
,
Required: True ,
}
enum ,
expires_after:
{
Description: Details on when this vector store expires ,
Required: False ,
}
{
anchor:
{
Description: Anchor timestamp after which the expiration policy applies. Supported anchors: `last_active_at`. ,
Enum:
{
last_active_at: The expiration policy is based on the last time the vector store was active. ,
}
,
Required: True ,
}
enum ,
days:
{
Description: The anchor timestamp after which the expiration policy applies. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
expires_at:
{
Description: The Unix timestamp (in seconds) for when the vector store will expire. ,
Format: unixtime ,
Required: False ,
}
integer ,
last_active_at:
{
Description: The Unix timestamp (in seconds) for when the vector store was last active. ,
Format: unixtime ,
Required: True ,
}
integer ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: True ,
}
object ,
}
,
]
,
first_id:
{
Description: The first ID represented in this list. ,
Required: True ,
}
string ,
last_id:
{
Description: The last ID represented in this list. ,
Required: True ,
}
string ,
has_more:
{
Description: A value indicating whether there are additional values available not captured in this list. ,
Required: True ,
}
boolean ,
}
ListVectorStoreFileBatchFiles (updated)
Description :  Returns a list of vector store files in a batch.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ListVectorStoreFileBatchFiles",
  "$parameters": [
    {
      "#name": "before",
      "Description": {
        "new": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.",
        "old": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list."
      }
    }
  ]
}

⚼ Request

GET:  /vector_stores/{vectorStoreId}/file_batches/{batchId}/files
{
vectorStoreId:
{
Description: The ID of the vector store that the file batch belongs to. ,
Required: True ,
}
string ,
batchId:
{
Description: The ID of the file batch that the files belong to. ,
Required: True ,
}
string ,
filter:
{
Description: Filter by file status. ,
Required: False ,
}
string ,
limit:
{
Description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. ,
Format: int32 ,
Required: False ,
}
integer ,
order:
{
Description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. ,
Required: False ,
}
string ,
after:
{
Description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. ,
Required: False ,
}
string ,
before:
{
Description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: The object type, which is always list. ,
Enum:
{
list: No description available. ,
}
,
Required: True ,
}
enum ,
data:
{
Description: The requested list of items. ,
Required: True ,
}
[
{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always `vector_store.file`. ,
Enum:
{
vector_store.file: No description available. ,
}
,
Required: True ,
}
enum ,
usage_bytes:
{
Description: The total vector store usage in bytes. Note that this may be different from the original file size. ,
Format: int32 ,
Required: True ,
}
integer ,
created_at:
{
Description: The Unix timestamp (in seconds) for when the vector store file was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
vector_store_id:
{
Description: The ID of the vector store that the file is attached to. ,
Required: True ,
}
string ,
status:
{
Description: The status of the vector store file, which can be either `in_progress`, `completed`, `cancelled`, or `failed`. The status `completed` indicates that the vector store file is ready for use. ,
Enum:
{
in_progress: The file is currently being processed. ,
completed: The file has been successfully processed. ,
failed: The file has failed to process. ,
cancelled: The file was cancelled. ,
}
,
Required: True ,
}
enum ,
last_error:
{
Description: The last error associated with this vector store file. Will be `null` if there are no errors. ,
Required: True ,
}
object ,
chunking_strategy:
{
Description: The strategy used to chunk the file. ,
Required: True ,
}
{
type:
{
Description: The object type. ,
Enum:
{
other: No description available. ,
static: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
first_id:
{
Description: The first ID represented in this list. ,
Required: True ,
}
string ,
last_id:
{
Description: The last ID represented in this list. ,
Required: True ,
}
string ,
has_more:
{
Description: A value indicating whether there are additional values available not captured in this list. ,
Required: True ,
}
boolean ,
}
ListVectorStoreFiles (updated)
Description :  Returns a list of vector store files.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ListVectorStoreFiles",
  "$parameters": [
    {
      "#name": "before",
      "Description": {
        "new": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.",
        "old": "A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list."
      }
    }
  ]
}

⚼ Request

GET:  /vector_stores/{vectorStoreId}/files
{
vectorStoreId:
{
Description: The ID of the vector store that the files belong to. ,
Required: True ,
}
string ,
filter:
{
Description: Filter by file status. ,
Required: False ,
}
string ,
limit:
{
Description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. ,
Format: int32 ,
Required: False ,
}
integer ,
order:
{
Description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. ,
Required: False ,
}
string ,
after:
{
Description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. ,
Required: False ,
}
string ,
before:
{
Description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: The object type, which is always list. ,
Enum:
{
list: No description available. ,
}
,
Required: True ,
}
enum ,
data:
{
Description: The requested list of items. ,
Required: True ,
}
[
{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always `vector_store.file`. ,
Enum:
{
vector_store.file: No description available. ,
}
,
Required: True ,
}
enum ,
usage_bytes:
{
Description: The total vector store usage in bytes. Note that this may be different from the original file size. ,
Format: int32 ,
Required: True ,
}
integer ,
created_at:
{
Description: The Unix timestamp (in seconds) for when the vector store file was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
vector_store_id:
{
Description: The ID of the vector store that the file is attached to. ,
Required: True ,
}
string ,
status:
{
Description: The status of the vector store file, which can be either `in_progress`, `completed`, `cancelled`, or `failed`. The status `completed` indicates that the vector store file is ready for use. ,
Enum:
{
in_progress: The file is currently being processed. ,
completed: The file has been successfully processed. ,
failed: The file has failed to process. ,
cancelled: The file was cancelled. ,
}
,
Required: True ,
}
enum ,
last_error:
{
Description: The last error associated with this vector store file. Will be `null` if there are no errors. ,
Required: True ,
}
object ,
chunking_strategy:
{
Description: The strategy used to chunk the file. ,
Required: True ,
}
{
type:
{
Description: The object type. ,
Enum:
{
other: No description available. ,
static: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
first_id:
{
Description: The first ID represented in this list. ,
Required: True ,
}
string ,
last_id:
{
Description: The last ID represented in this list. ,
Required: True ,
}
string ,
has_more:
{
Description: A value indicating whether there are additional values available not captured in this list. ,
Required: True ,
}
boolean ,
}